Request a tracklink report result Schema
api_result Element
Description
starts a results connection.
Namespace (none)
Diagram
result Element num_results Element authentication Element Sequence api_result Element
Overview
api_result
starts a results connection.
Sequence
authentication xs:string
Confirmation that the username and password has been accepted.
num_results xs:int
Defines the number of results in this report.
result 0..∞
You can have multiple results per tracklink report.  There are two types of results.  An "email_open" and a "link_click".  The only difference in information returned is that the "link_click" type will have an <href> element as well as the other elements.
Sequence
type xs:string
There are two possible types "email_open" and "link_click". 
job_num xs:string
This is the number that the PRODOCOM production system uses to identify a specific job.  This will be an 8 digit alpha numeric field and is used to identify a particular job.  The job_num can also be used in the PRODOCOM web portal to locate a job in the reporting option.
date_gmt xs:string
The GMT (Greenwich Mean time) date of the email being opened or the link being clicked.
href optional xs:string
This will display the URL that the recipient clicked on.
recipient xs:string
This will display the recipients email address.
Source
<xs:element name="api_result" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="authentication" />
      <xs:element type="xs:int" name="num_results" />
      <xs:element name="result" maxOccurs="unbounded" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="type" />
            <xs:element type="xs:string" name="job_num" />
            <xs:element type="xs:string" name="date_gmt" />
            <xs:element type="xs:string" name="href" minOccurs="0" />
            <xs:element type="xs:string" name="recipient" />
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
Request a tracklink report result Schema

 

 


© 2013 All Rights Reserved.

Send comments on this topic.